/*
    mpi.h

    by Michael J. Fromberger <sting@linguist.dartmouth.edu>
    Copyright (C) 1998 Michael J. Fromberger, All Rights Reserved

    Arbitrary precision integer arithmetic library

    $Id: mpi.h,v 1.11 2001/04/27 18:55:09 sting Exp $
 */

#ifndef _H_MPI_
#define _H_MPI_

/* From mpi-config.h */
/*
  For boolean options,
  0 = no
  1 = yes

  Other options are documented individually.

 */

#ifndef MP_IOFUNC
#define MP_IOFUNC 1 /* include mp_print() ?                */
#endif

#ifndef MP_MODARITH
#define MP_MODARITH 1 /* include modular arithmetic ?        */
#endif

#ifndef MP_NUMTH
#define MP_NUMTH 1 /* include number theoretic functions? */
#endif

#ifndef MP_MEMSET
#define MP_MEMSET 1 /* use memset() to zero buffers?       */
#endif

#ifndef MP_MEMCPY
#define MP_MEMCPY 1 /* use memcpy() to copy buffers?       */
#endif

#ifndef MP_CRYPTO
#define MP_CRYPTO 0 /* erase memory on free?               */
#endif

#ifndef MP_ARGCHK
/*
  0 = no parameter checks
  1 = runtime checks, continue execution and return an error to caller
  2 = assertions; dump core on parameter errors
 */
#define MP_ARGCHK 2 /* how to check input arguments        */
#endif

#ifndef MP_DEBUG
#define MP_DEBUG 0 /* print diagnostic output?            */
#endif

#ifndef MP_DEFPREC
#define MP_DEFPREC 16 /* default precision, in digits        */
#endif

#ifndef MP_MACRO
#define MP_MACRO 1 /* use macros for frequent calls?      */
#endif

#ifndef MP_SQUARE
#define MP_SQUARE 1 /* use separate squaring code?         */
#endif

#ifndef MP_PTAB_SIZE
/*
  When building mpprime.c, we build in a table of small prime
  values to use for primality testing.  The more you include,
  the more space they take up.  See primes.c for the possible
  values (currently 16, 32, 64, 128, 256, and 6542)
 */
#define MP_PTAB_SIZE 128 /* how many built-in primes?         */
#endif

#if MP_DEBUG
#undef MP_IOFUNC
#define MP_IOFUNC 1
#endif

#if MP_IOFUNC
#include <stdio.h>
#include <ctype.h>
#endif

#include <limits.h>

#define MP_NEG 1
#define MP_ZPOS 0

/* Included for compatibility... */
#define NEG MP_NEG
#define ZPOS MP_ZPOS

#define MP_OKAY 0    /* no error, all is well */
#define MP_YES 0     /* yes (boolean result)  */
#define MP_NO -1     /* no (boolean result)   */
#define MP_MEM -2    /* out of memory         */
#define MP_RANGE -3  /* argument out of range */
#define MP_BADARG -4 /* invalid parameter     */
#define MP_UNDEF -5  /* answer is undefined   */
#define MP_LAST_CODE MP_UNDEF

typedef char mp_sign;
typedef unsigned short mp_digit;
typedef unsigned int mp_word;
typedef unsigned int mp_size;
typedef int mp_err;

#define MP_DIGIT_BIT (CHAR_BIT * sizeof(mp_digit))
#define MP_DIGIT_MAX USHRT_MAX
#define MP_WORD_BIT (CHAR_BIT * sizeof(mp_word))
#define MP_WORD_MAX UINT_MAX
#define RADIX (MP_DIGIT_MAX + 1)

/* Included for compatibility... */
#define DIGIT_BIT MP_DIGIT_BIT
#define DIGIT_MAX MP_DIGIT_MAX

#define DIGIT_FMT "%04X" /* printf() format for 1 digit */

/* Macros for accessing the mp_int internals           */
#define SIGN(MP) ((MP)->sign)
#define USED(MP) ((MP)->used)
#define ALLOC(MP) ((MP)->alloc)
#define DIGITS(MP) ((MP)->dp)
#define DIGIT(MP, N) (MP)->dp[(N)]

#if MP_ARGCHK == 1
#define ARGCHK(X, Y) \
  {                  \
    if (!(X)) {      \
      return (Y);    \
    }                \
  }
#elif MP_ARGCHK == 2
#include <assert.h>
#define ARGCHK(X, Y) assert(X)
#else
#define ARGCHK(X, Y) /*  */
#endif

/* This defines the maximum I/O base (minimum is 2)   */
#define MAX_RADIX 64

typedef struct {
  mp_sign sign;  /* sign of this quantity      */
  mp_size alloc; /* how many digits allocated  */
  mp_size used;  /* how many digits used       */
  mp_digit *dp;  /* the digits themselves      */
} mp_int;

/* Default precision       */
unsigned int mp_get_prec(void);
void mp_set_prec(unsigned int prec);

/* Memory management       */
mp_err mp_init(mp_int *mp);
mp_err mp_init_size(mp_int *mp, mp_size prec);
mp_err mp_init_copy(mp_int *mp, mp_int *from);
mp_err mp_copy(mp_int *from, mp_int *to);
void mp_exch(mp_int *mp1, mp_int *mp2);
void mp_clear(mp_int *mp);
void mp_zero(mp_int *mp);
void mp_set(mp_int *mp, mp_digit d);
mp_err mp_set_int(mp_int *mp, long z);

/* Single digit arithmetic */
mp_err mp_add_d(mp_int *a, mp_digit d, mp_int *b);
mp_err mp_sub_d(mp_int *a, mp_digit d, mp_int *b);
mp_err mp_mul_d(mp_int *a, mp_digit d, mp_int *b);
mp_err mp_mul_2(mp_int *a, mp_int *c);
mp_err mp_div_d(mp_int *a, mp_digit d, mp_int *q, mp_digit *r);
mp_err mp_div_2(mp_int *a, mp_int *c);
mp_err mp_expt_d(mp_int *a, mp_digit d, mp_int *c);

/* Sign manipulations      */
mp_err mp_abs(mp_int *a, mp_int *b);
mp_err mp_neg(mp_int *a, mp_int *b);

/* Full arithmetic         */
mp_err mp_add(mp_int *a, mp_int *b, mp_int *c);
mp_err mp_sub(mp_int *a, mp_int *b, mp_int *c);
mp_err mp_mul(mp_int *a, mp_int *b, mp_int *c);
#if MP_SQUARE
mp_err mp_sqr(mp_int *a, mp_int *b);
#else
#define mp_sqr(a, b) mp_mul(a, a, b)
#endif
mp_err mp_div(mp_int *a, mp_int *b, mp_int *q, mp_int *r);
mp_err mp_div_2d(mp_int *a, mp_digit d, mp_int *q, mp_int *r);
mp_err mp_expt(mp_int *a, mp_int *b, mp_int *c);
mp_err mp_2expt(mp_int *a, mp_digit k);
mp_err mp_sqrt(mp_int *a, mp_int *b);

/* Modular arithmetic      */
#if MP_MODARITH
mp_err mp_mod(mp_int *a, mp_int *m, mp_int *c);
mp_err mp_mod_d(mp_int *a, mp_digit d, mp_digit *c);
mp_err mp_addmod(mp_int *a, mp_int *b, mp_int *m, mp_int *c);
mp_err mp_submod(mp_int *a, mp_int *b, mp_int *m, mp_int *c);
mp_err mp_mulmod(mp_int *a, mp_int *b, mp_int *m, mp_int *c);
#if MP_SQUARE
mp_err mp_sqrmod(mp_int *a, mp_int *m, mp_int *c);
#else
#define mp_sqrmod(a, m, c) mp_mulmod(a, a, m, c)
#endif
mp_err mp_exptmod(mp_int *a, mp_int *b, mp_int *m, mp_int *c);
mp_err mp_exptmod_d(mp_int *a, mp_digit d, mp_int *m, mp_int *c);
#endif /* MP_MODARITH */

/* Comparisons             */
int mp_cmp_z(mp_int *a);
int mp_cmp_d(mp_int *a, mp_digit d);
int mp_cmp(mp_int *a, mp_int *b);
int mp_cmp_mag(mp_int *a, mp_int *b);
int mp_cmp_int(mp_int *a, long z);
int mp_isodd(mp_int *a);
int mp_iseven(mp_int *a);

/* Number theoretic        */
#if MP_NUMTH
mp_err mp_gcd(mp_int *a, mp_int *b, mp_int *c);
mp_err mp_lcm(mp_int *a, mp_int *b, mp_int *c);
mp_err mp_xgcd(mp_int *a, mp_int *b, mp_int *g, mp_int *x, mp_int *y);
mp_err mp_invmod(mp_int *a, mp_int *m, mp_int *c);
#endif /* end MP_NUMTH */

/* Input and output        */
#if MP_IOFUNC
void mp_print(mp_int *mp, FILE *ofp);
#endif /* end MP_IOFUNC */

/* Base conversion         */
#define BITS 1
#define BYTES CHAR_BIT

mp_err mp_read_raw(mp_int *mp, char *str, int len);
int mp_raw_size(mp_int *mp);
mp_err mp_toraw(mp_int *mp, char *str);
mp_err mp_read_mag(mp_int *mp, char *str, int len);
int mp_mag_size(mp_int *mp);
mp_err mp_tomag(mp_int *mp, char *str);

mp_err mp_read_radix(mp_int *mp, char *str, int radix);
int mp_radix_size(mp_int *mp, int radix);
int mp_value_radix_size(int num, int qty, int radix);
mp_err mp_toradix(mp_int *mp, char *str, int radix);
int mp_tovalue(char ch, int r);

#define mp_tobinary(M, S) mp_toradix((M), (S), 2)
#define mp_tooctal(M, S) mp_toradix((M), (S), 8)
#define mp_todecimal(M, S) mp_toradix((M), (S), 10)
#define mp_tohex(M, S) mp_toradix((M), (S), 16)

/* Error strings           */
const char *mp_strerror(mp_err ec);

/* Added by Anthony Mulcahy for borZoi */
mp_err mp_and(mp_int *a, mp_int *b, mp_int *c);
mp_err mp_or(mp_int *a, mp_int *b, mp_int *c);
mp_err mp_xor(mp_int *a, mp_int *b, mp_int *c);
mp_err mp_gen_random(mp_int *a, unsigned long n);
mp_err mp_left_shift(mp_int *a, mp_digit n);
void mp_right_shift(mp_int *a, mp_digit n);
unsigned char mp_tooctet(mp_int *a);
int mp_getbit(mp_int *v, unsigned long n);
int mp_msb(mp_int *v);
mp_err poly_F2x_div(mp_int *a, mp_int *b, mp_int *q, mp_int *r);
mp_err poly_F2x_mod(mp_int *a, mp_int *m, mp_int *c);
mp_err poly_F2x_mulmod(mp_int *a, mp_int *b, mp_int *m, mp_int *c);

mp_err F2x_multiply(mp_int *a, mp_int *b, mp_int *c);
mp_err F2m_square(mp_int *a, mp_int *f, mp_int *b);
mp_err F2m_inverse(mp_int *a, mp_int *f, mp_int *b);
#endif /* end _H_MPI_ */
